home *** CD-ROM | disk | FTP | other *** search
/ Scene 96 / Scene 96 International Edition (Zyklop Software) (Disc 2) (1997).iso / programs / stsemu31 / ym.doc < prev    next >
Text File  |  1996-10-16  |  12KB  |  402 lines
  1.  
  2.     ╔═─────────────────────────────────────────────────────────═╗
  3.         │             Yamaha YM2149 Chip Emulator v3.12             │
  4.         │                      (December 1996)                      │
  5.         │     Copyright (C) 1996 Arnaud Carre (Leonard/OXYGENE)     │
  6.         │      NEWS: windows version, works on all soundcards !     │
  7.     ╚═─────────────────────────────────────────────────────────═╝
  8.  
  9.  
  10.    INDEX:
  11.  
  12.  
  13.     1) WHAT'S NEW ??
  14.     2) PACKAGE LIST
  15.     3) HOW DOES IT WORKS
  16.     4) KEY FUNCTIONS
  17.     5) COMMAND LINE PARAMETERS
  18.     6) PROBLEMS ??
  19.     7) THE FUTUR...
  20.     8) CREDITS, GREETINGS AND THANKS
  21.     9) CONTACTING THE AUTHOR
  22.  
  23.  
  24.  
  25.  
  26. ──────────────────────────────────────────────────────────────────────────────
  27.  
  28.                WHAT DOES YM ?
  29.  
  30.    YM is a software YM2149 chip emulator. This chip is a FM synthethic
  31.    sound processor. It is inclued in the AMSTRAD CPC and in the ATARI-ST.
  32.    So you can play music from these both machine with YM !!
  33.  
  34.    For emulation, you need a SoundBlaster(TM) card for the DOS version,
  35.    or any card for the WINDOWS version.
  36.  
  37.  
  38.  
  39.  
  40.               CARDWARE REGISTRATION
  41.  
  42.    YM is  "cardware". That  means, if  you like  this program  you
  43.    are strongly  encouraged  to  become  a  registered  user  by
  44.    sending a nice illustrated  postcard  to  me.   This  helps  me
  45.    getting  motivated  in programming upgrades and further productions.
  46.    Please DON'T send  letters or  emails  as  a  substitute  for  a
  47.    real postcard.
  48.  
  49.    If you have any  comments, bug reports, help  or criticism feel free  to
  50.    contact me.  You will find my address at the bottom of this text file.
  51.  
  52.  
  53.  
  54.  
  55.  
  56. ──────────────────────────────────────────────────────────────────────────────
  57.  
  58.    1) WHAT'S NEW ??
  59.  
  60.  
  61.     NEW !! YM has a WINDOWS version, wich works on all SoundCard !!
  62.  
  63.  
  64.     v1.0: YM emulate an YM2149 without volume and waveform.
  65.  
  66.     v1.1: Add volume emulation.
  67.  
  68.     v2.0: Add waveform emulation. (for madmax buzzer !)
  69.  
  70.     v2.1: Add graphic stuff (scopes...)
  71.  
  72.     v2.2: Add many options. (Direct to disk etc...)
  73.  
  74.     v3.0: Add madmax DigiDrum !!
  75.  
  76.     v3.01: Add File selector.
  77.  
  78.         v3.02: New Packed-YM format.
  79.  
  80.     v3.03: -Some bugs removed in FileSelector on CDROM (Thanks
  81.         Lester!)
  82.            -Drive change in FileSelector
  83.  
  84.     v3.10 : Windows 95 version.
  85.         Enveloppe and Noise generator Improved.
  86.         (Better sound quality !)
  87.         Bug removed in WAV sample generation.
  88.                 YM File format documentation.
  89.  
  90.     v3.12:    - No change on the DOS-Version.
  91.         - Bug removed in each beginning of the song.
  92.           (Many thanks to Adam Lorentzon for the solution !)
  93.         - Music path-name is saved in YM.INI
  94.  
  95. ──────────────────────────────────────────────────────────────────────────────
  96.  
  97.    2) PACKAGE LIST:
  98.  
  99.    Original files for that version of package:
  100.  
  101.    YM       .EXE        Music Player. (DOS Version)
  102.    YM95     .EXE    Music Player. (WINDOWS 32bits Version)
  103.    YM       .DOC        That document.
  104.    README   .DOC        Some comments.
  105.    FILE_ID  .DIZ    Advert for BBS support.
  106.    YMFORMAT .TXT        Informations about YM-File format.
  107.  
  108.  
  109. ──────────────────────────────────────────────────────────────────────────────
  110.  
  111.    3) HOW DOES IT WORKS
  112.  
  113.  
  114.    YM.EXE works on 386 or higher machine, with 4MB of RAM. YM can play
  115.    synthetic tunes in real-time on your PC by playing a micro-sample,
  116.    rebuilt 50 times per second. On the other hand, if you have no
  117.    replay card, YM can generate a big sample (.WAV) on your hard-disk
  118.    for later.
  119.  
  120.    The Windows version works with ANY soundcard !! (That is, it works
  121.    on GUS !).
  122.  
  123.    If you use the DOS version, you must have a SoundBlaster(TM) or
  124.    compatible card. You don't need to load SoundBlaster drivers, just
  125.    declare the SB environement string.
  126.    (Ex: SET BLASTER=A220 I5 D1 . YM needs only A,I and D)
  127.  
  128.  
  129.    ┌─────────────────────┐
  130.    │    DIRECT-TO-DISK   │
  131.    └─────────────────────┘
  132.  
  133.     YM can generate music as sample file. (.WAV)
  134.     Just type "YM -dwave_name musicname"
  135.  
  136.     Ex:
  137.         "ym -dsample beatnick"
  138.  
  139.         Generate the sample "sample.wav" with the music
  140.         "beatnick.ym".
  141.  
  142.  
  143.  
  144. ──────────────────────────────────────────────────────────────────────────────
  145.  
  146.    4) KEY FUNCTIONS:
  147.  
  148.  
  149.    When you are in YM, the following keys are available:
  150.  
  151.       ┌──────────┐
  152.       │    KEYS:    │
  153.       └──────────┘
  154.  
  155.    1            - Switch ON/OFF voice 1
  156.    2            - Switch ON/OFF voice 2
  157.    3            - Switch ON/OFF voice 3
  158.  
  159.    4            - More panning to LEFT
  160.    5            - Panning to MIDDLE
  161.    6            - More panning to RIGHT
  162.  
  163.    d            - Dos-Shell (Not available in GRAPHIC-scope mode)
  164.    ESC          - Quit YM
  165.    TAB          - See YM-Emulation CPU time.
  166.  
  167.    F1           - Use Square tone synthese
  168.    F2           - Use Sinus tone synthese
  169.    F3           - Use Triangular tone synthese
  170.    F4           - Use Sawtooth A tone synthese
  171.    F5           - Use Sawtooth B tone synthese
  172.  
  173.    v            - Switch ON/OFF logarithm / linear volume.
  174.  
  175.    PLUS         - Increase Output volume.
  176.    MINUS        - Decrease Output volume.
  177.  
  178.    KEY RIGHT    - Fast forward in music.
  179.    KEY LEFT     - Fast rewind.
  180.  
  181.  
  182.       ┌─────────────────────┐
  183.       │ FILE-SELECTOR KEYS: │
  184.       └─────────────────────┘
  185.  
  186.    ARROW KEYS      - Move cursor.
  187.    RETURN or SPACE - Select file or open Directory.
  188.    [a..z]          - Move cursor to first file-letter.
  189.    SHIFT + [a..z]  - Change current drive.
  190.    CTRL PAGE-UP    - Back to previous directory.
  191.  
  192.  
  193.  
  194.  
  195.  
  196.  
  197. ──────────────────────────────────────────────────────────────────────────────
  198.  
  199.    5) THE COMMAND LINE PARAMETERS:
  200.  
  201.     Usage: YM [-dFILENAME] [-tTIME] [-options] <music file>
  202.  
  203.         <music file> : Music file (.YM)
  204.         -dFILENAME : Save a sample (.WAV) Direct to disk.
  205.         -tTIME     : Generate TIME sec of "direct to disk" sample
  206.         -i         : Music file Information. (Time,etc...)
  207.         -eTYPE     : Synthetic tone type:
  208.                     0 : Square (Default YM tone)
  209.                     1 : Sinus
  210.                     2 : Triangle
  211.                     3 : Sawtooth A
  212.                     4 : Sawtooth B
  213.         -g         : Graphical scope.
  214.         -fTYPE     : Force SB Detection (0:SB8,1:SBPRO,2:SB16)
  215.         -l         : Desable LOOP mode. (Music stop when finished)
  216.         -v         : Use Linear Volume instead of Logarithmic.
  217.                  (Default is log, as the YM2149 chip)
  218.         -oVALUE    : Force the Output volume (0 to 255)
  219.         -om        : Force the output volume to maximum.
  220.         -r         : Use Real 4bits ST digi-drums.
  221.  
  222.  
  223.     Example:
  224.  
  225.       YM            : Run YM with the file-selector.
  226.  
  227.       YM mus2       : Play mus2.YM in text mode.
  228.  
  229.       YM -g mus2    : Play mus2.YM in graphic mode.
  230.  
  231.       YM mus2 -e1   : Play mus2.YM with sinus-tone synthesis.
  232.  
  233.       YM -dtest -t60 mus2 : Generate the sample TEST.WAV with the
  234.                 60 first sec of mus2.YM
  235.  
  236.       YM beatnick -g -r :   Play beatnick.ym with "g"raphical scope,
  237.                 using "r"eal 4 bits digi-drums.
  238.  
  239.  
  240. ──────────────────────────────────────────────────────────────────────────────
  241.  
  242.  
  243.     6) PROBLEMS ??
  244.  
  245.  
  246.     -------------------------------------------------------------------
  247.  
  248.     Q: When I start YM.EXE it says "BLASTER environement string not
  249.        found".
  250.  
  251.     A: You must specify the BLASTER string environement as follow:
  252.        At the dos prompt type:
  253.  
  254.        SET BLASTER=Axxx Iy Dz
  255.  
  256.        Where xxx is the card adress in hex, y is the IRQ and z the
  257.        DMA channel. Ex: if your SB card is configured at the adress
  258.        0x220, IRQ 5 and DMA channel number 1 type:
  259.  
  260.        SET BLASTER=A220 I5 D1
  261.  
  262.        You don't need to load SoundBlaster(TM) drivers.
  263.        If you havn't any soundcard use the "-d" option.
  264.  
  265.     -------------------------------------------------------------------
  266.  
  267.     Q: When I start YM.EXE I can read the error message:
  268.        "ERROR: Buffer boundary failed."
  269.  
  270.     A: The buffer allocated in conventionnal memory must be in one
  271.            64Kb page. If error, change your config.sys by adding or
  272.            removing some residents.
  273.  
  274.     -------------------------------------------------------------------
  275.  
  276.     Q: When YM play music the volume is very low.
  277.  
  278.     A: YM don't modify SB-Mixer parameters when starting. So
  279.        if your mixer volume is too low you can use the option "-om"
  280.        to reset mixer at maximum volume. (Especially usefull on
  281.        SoundBlaster 16)
  282.  
  283.     -------------------------------------------------------------------
  284.  
  285.     Q: When I play YM with -g option, graphical scopes are moving
  286.        but no sound.
  287.  
  288.     A: It seems that you have not a SoundBlaster(TM) card but a
  289.        "compatible" one. You should try with or without the "-om"
  290.        option to force card to be reseted.
  291.  
  292. ──────────────────────────────────────────────────────────────────────────────
  293.  
  294.     7) THE FUTUR...
  295.  
  296.  
  297.     First off all I want to convert an ATARI-ST universal MADMAX
  298.     player written by MCODER. It will allow to play more than 250
  299.     atari soundchip tunes with my emulator, in less 500Kb of data,
  300.     but I haven't any time to do that...
  301.  
  302.     Second If you are interested, I search a cool guy who can do YM
  303.     files from the AMSTRAD CPC 6128. (Write me for infos about the
  304.     .YM format if you can convert AMSTRAD musics).
  305.  
  306.     I have done some other stuff on PC, contact me if you are
  307.     interested by some of these subject (If you have infos or
  308.     documentation send me !):
  309.  
  310.     -ATARI ST - PC developement kit (paralele link)
  311.     -AMIGA Remote-debuger on PC (you can trace code on PC !)
  312.     -Many other strange stuff. (Ex: Conway life's game,
  313.     data encoding, compression etc...)
  314.  
  315.  
  316.     Last: few days ago, I've done an AMIGA-Futur composer v1.4 play
  317.     routine for the ATARI STE. Soon a TT and FALCON conversion by 
  318.     Mr Bee.  Contact me if you are interested... 
  319.  
  320.     Now Available: A PC-WINDOWS version of AMIGA FUTUR-Composer !
  321.     (FCWIN). Contact me for infos...
  322.  
  323.  
  324.  
  325. ──────────────────────────────────────────────────────────────────────────────
  326.  
  327.     8) CREDITS, GREETINGS AND THANKS
  328.  
  329.  
  330.     To do YM, I have collected many documents and Tips around, so
  331.     here are some thanks to people who helped me:
  332.  
  333.  
  334.     - Special thanks to Mister BEE to help me with YM2149 output
  335.       signal analysis.
  336.  
  337.     - GRIFF, for writing ST-Sound emulation part of the STonX
  338.       emulator. (ATARI-ST emulator on UNIX system)
  339.  
  340.     - BEN for technical informations about YM frequency and
  341.       MADMAX's "buzz" usage.
  342.  
  343.     - TGA to lend us (Mr.BEE and me) the oscillo.
  344.  
  345.     - MCoder for ripping and collecting all these marvellous tunes
  346.       (He wrote a demo with 257 MADMAX's best musics. Maybe I
  347.       convert it later on PC...)
  348.  
  349.     - Charles Scheffold and Thomas Pytel for their fantastic
  350.       DOS-Extender.
  351.  
  352.     - Haruyasu Yoshizaki for his powerfull archiver named LHA.
  353.  
  354.     - Adam Lorentzon (<d93-alo@nada.kth.se>) to help me in the
  355.       Windows version of YM.
  356.  
  357.  
  358.  
  359.  
  360. Flying regards to:
  361.  
  362.     OXYGENE members: Lester, Mon, Nap, Oxbab, Spiral, Sun Stark.
  363.  
  364.     Others: DIM,
  365.         Dogue de Mauve (So long time...)
  366.         Ziggy Stardust
  367.         Guillaume (GG) (I know you read .DOC files !)
  368.         Ben & Jess,
  369.         Claudius (Sol Carlus)
  370.         Bozo (Bozo Tool Kit)
  371.         Fury,
  372.         BigFoot,
  373.         Niko,
  374.         Zappy,
  375.         Griffon,
  376.         Aeon of Aura (hi all !)
  377.  
  378.  
  379.  
  380. ──────────────────────────────────────────────────────────────────────────────
  381.  
  382.     9) CONTACTING THE AUTHOR:
  383.  
  384.  
  385.  
  386.       Internet e-mail:
  387.  
  388.     acarre%siam@cal.fr
  389.  
  390.  
  391.       mailing address:  Arnaud Carre
  392.             22 rue JEAN MERMOZ
  393.             91700 Ste Genevieve des Bois
  394.             FRANCE
  395.  
  396.  
  397.       or with the "french MINITEL":
  398.  
  399.       3615 RTEL , BAL "LEONHARD" (With a 'H')
  400.  
  401. ──────────────────────────────────────────────────────────────────────────────
  402.